@@ -15,31 +15,30 @@ Then, use the included scripts to install Archi Back:
...
@@ -15,31 +15,30 @@ Then, use the included scripts to install Archi Back:
- On Windows, launch `setup.bat`.
- On Windows, launch `setup.bat`.
- On Linux/macOS, open a terminal inside the directory of the project then write
- On Linux/macOS, open a terminal inside the directory of the project then write
```bash
```bash
chmod +x ./setup.sh && ./setup.sh
chmod +x ./setup.sh && ./setup.sh
```
```
## Usage
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
First, you should launch the back-end part:
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
- On Windows, launch `run.bat`.
## Roadmap
- On Linux/macOS, open a terminal inside the directory of the project then write
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
```bash
State if you are open to contributions and what your requirements are for accepting them.
chmod +x ./run.sh && ./run.sh
```
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
Then, launch the front-end part with the instructions available
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors
## Authors and acknowledgment
Renaud Birk and Anas Yakoubov
Show your appreciation to those who have contributed to the project.
## License
## License
For open source projects, say how it is licensed.
## Project status
This project is licensed under GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
