Skip to content

Commit

Permalink
better setup for read me
Browse files Browse the repository at this point in the history
  • Loading branch information
LennartJKlein committed Dec 15, 2017
1 parent bc95618 commit 189011f
Showing 1 changed file with 27 additions and 27 deletions.
54 changes: 27 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,6 @@ This last step however, the physical real-world process of connecting the gates,

The algorithms and content of the sample has been setup to create paths from predefined net lists and two boards that can be found in sample/data. So in short, the aim is to connect the dots (gates) in a efficient manner.

## Notable content:

### Docs/html
The [documentations](https://lennartjklein.github.io/pathfinder/) of the classes and helper functions used in sample. The documentations are made by Sphinx, a docstring converter.

### Experimtents
One experiment is documented at the moment. We used a random netlist creator and random board creator to see how the used algorithms preformed.

### Sample
Sample is the core of our repository.
\___main.\___.py is the core of the core. It makes use of classes.py and helpers.py to drive the algorithms to solve the case.
Aditions are colors.py for adding terminal colors and settings.py. settings.py can be used to modify the program but more on that in de README.md in the sample directory.

## Requirements
To run this program, you need the following:

* [Python](https://www.python.org/downloads/) 3.6.3
* [numpy](http://www.numpy.org/) 1.13.3
* [matplotlib](https://matplotlib.org/index.html) 2.1.0

## Installation

Clone or download this repository (containing the pathfinder module) to a folder of your preference. Make sure the requirements above are installed to be able to run the program.

## Definitions:
*Board*: The board a three dimensional grid with a presetted height, weight and depth.

Expand All @@ -41,17 +17,37 @@ Clone or download this repository (containing the pathfinder module) to a folder

*Path*: A path from gate to gate, walking over the board. It cannot move diagonally only in one of six directions: north, south, west, east, up and down.

*Netlist*: A list of connections
*Net list*: A list of connections

*Score* of a board: The total sum of the lengths of all connected paths.

*Result* of a board: The percentage of made connections from the netlist.

*Solvability of a board*: The average calculated percentage of a board with randomly placed gates and random netlists.

## Contributing
## Content of the program

This project is not open for contributing at the moment, for it being a school assignment.
### Docs/html
The [documentations](https://lennartjklein.github.io/pathfinder/) of the classes and helper functions used in sample. The documentations are made by Sphinx, a docstring converter.

### Experimtents
One experiment is documented at the moment. We used a random netlist creator and random board creator to see how the used algorithms preformed.

### Sample
Sample is the core of our repository.
\___main.\___.py is the core of the core. It makes use of classes.py and helpers.py to drive the algorithms to solve the case.
Aditions are colors.py for adding terminal colors and settings.py. settings.py can be used to modify the program but more on that in de README.md in the sample directory.

## Installation

Clone or download this repository (containing the pathfinder module) to a folder of your preference. Make sure the requirements above are installed to be able to run the program.

### Requirements
To run this program, you need the following:

* [Python](https://www.python.org/downloads/) 3.6.3
* [numpy](http://www.numpy.org/) 1.13.3
* [matplotlib](https://matplotlib.org/index.html) 2.1.0

## Versioning

Expand All @@ -63,6 +59,10 @@ We use [SemVer](http://semver.org/) for semantic versioning. For the versions av
* **Lennart Klein** - *Webdeveloper and webdesigner* - [www.lennartklein.nl](http://www.lennartklein.nl/)
* **Thomas de Lange** - *Developer* - [www.long-coding.nl](http://www.long-coding.nl/)

### Contributing

This project is not open for contributing at the moment, for it being a school assignment.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
Expand Down

0 comments on commit 189011f

Please sign in to comment.