updated makefile and readme

This commit is contained in:
ayabusa 2024-11-03 12:00:16 +01:00
parent 420c3503c2
commit fc8332b8f4
2 changed files with 38 additions and 2 deletions

View File

@ -1,3 +1,5 @@
PLATFORM := $(shell uname)
bonjour:
@echo " ------------------------------------"
@echo "| you can use "make build" or "make run" |"
@ -9,8 +11,11 @@ bonjour:
@echo " || ||"
build:
ifeq ($(PLATFORM),Win32)
go build -o bin/ecoledirecte_api.exe src/*
else
go build -o bin/ecoledirecte_api src/*
endif
run:
go build -o bin/ecoledirecte_api src/*.go
bin/ecoledirecte_api
go run src/*

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# EcoleDirecte API
Une interface simple pour récupérer son calendrier
# Lancer le programme
Il vous suffit d'installer [make](https://www.gnu.org/software/make/) et le compilateur [go](https://go.dev/) puis de lancer une des commandes suivantes:
Pour juste lancer le programme
```sh
make run
```
Pour le compiler dans un fichier executable
```sh
make build
```
# Licence
```
All Rights Reserved
Copyright (c) ED API
Created by Ayabusa
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```