This is the repository template for Software projects at MPM, TU Berlin. Fill it out with your project's information and you're good to go!
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
Here, you should list what software is required to run the project. For example, you might need to install OpenLCA (which version?), whether it runs on Windows, Mac, or Linux or whether a specific Python version is required.
Basically, if it is something you cannot install with a simple pip install, you should list it here.
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
- Clone the repo
git clone https://github.com/your_username_/Project-Name.git
- Install pip packages
pip install -r requirements.txt
Use this space to show useful examples of how a project can be used. For now, I will put some information about this template here.
The documentation for the project is stored here. The documentation is generated using Sphinx. You can add more documentation here by creating .rst files in the docs directory and referencing them in the index.rst file.
The source code for the project is stored here. You can add more source code files here. You should consider using different files or directories for different parts of your project.
The tests for the project are stored here. You can add more test files here. They should test the low-level building blocks of your project. Maybe there also can be some integration tests, which test the interaction of different parts of your project.
This file lists all the Python packages that are required to run the project. You can add more packages here if you need them.
This file contains the license for the project. You should choose a license that fits your needs. Choose an Open Source License
This file contains the information about the project. You should fill it out with information about your project.
This directory contains input files for the project. You can add more input files here.
This directory contains output files for the project. You can add more output files here.
This project is documented using the Sphinx documentation generator. The documentation is in the docs directory. Sphix-Autoapi is used to automatically generate documentation from the source code's docstrings. To build the documentation, run the following command:
source venv/bin/activate
cd docs
sphinx-build -b html . _buildThe documentation will be built in the _build directory. Open the index.html file in your browser to view the documentation.
- Add Changelog
- Add back to top links
- Add Additional Templates w/ Examples
- Multi-language Support
- Chinese
- Spanish
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the WTFPL License. See LICENSE.txt for more information. For your project, you should choose a license that fits your needs. Choose an Open Source License
Lu - [email protected]
Project Link: https://github.com/your_username/repo_name
Use this space to list resources you find helpful and would like to give credit to.