Skip to content

Commit c4a46d9

Browse files
committed
docs: initial commit
0 parents  commit c4a46d9

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

LICENSE.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2016 David Gowor
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Python port of Path of Building
2+
The goal of this repository is to eventually be able to port all of
3+
[Path of Building](https://github.com/PathOfBuildingCommunity/PathOfBuilding)
4+
from Lua to Python. Currently, it is mostly intended for exploring ideas on how to
5+
accomplish this.
6+
7+
## Install
8+
This project targets Python 3.9. You need to have Python 3.9 or later installed
9+
to run this project. Start off by cloning the repository like so:
10+
```commandline
11+
git clone -b dev https://github.com/PathOfBuildingCommunity/PathOfBuilding-Python.git
12+
```
13+
14+
## Usage
15+
This project is WIP and not generally useful yet, except for developers.
16+
17+
## Contributing
18+
Pull requests are welcome! This project is in its very early stages, so there
19+
are plenty of opportunities to contribute.
20+
21+
## Maintainers
22+
[@ppoelzl](https://github.com/ppoelzl)
23+
24+
## Licence
25+
[MIT](https://github.com/PathOfBuildingCommunity/PathOfBuilding-Python/blob/master/LICENSE.md)

0 commit comments

Comments
 (0)