Skip to content

Commit

Permalink
cleaning up doc files
Browse files Browse the repository at this point in the history
  • Loading branch information
mjwagner2 committed Mar 9, 2018
1 parent ce84dc8 commit 49184f5
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 20 deletions.
20 changes: 11 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ _I agree to contribute to SolarPILOT. I agree to the following terms and conditi

* SolarPILOT consists of [several code repositories](https://github.com/NREL/SolarPILOT/wiki/Software-Dependencies), so you will need to determine where to make your contribution. For example, if you are making a change to the way SolarPILOT's heliostat positioning algorithm model makes a calculation, you would work with the [SSC](https://github.com/NREL/SSC) repository. If you are adding a new feature that changes both calculations and the user interface, like adding a new layout algorithm, then you would work with both the SolarPILOT repository and the SSC repository. If you need help figuring out where your contribution should go, please [let us know](mailto://solarpilot.support@nrel.gov).

* We use GitHub to manage the open source project, so you will need to learn how to use it to fork, clone, branch, check out, pull, add, commit, and push your work.
* We use GitHub to manage the open source project, so you will need to learn how to use it to fork, clone, branch, check out, pull, add, commit, and push your work.

### Instructions

Expand All @@ -44,21 +44,23 @@ The repository is organized into several branches, and some have special importa
<tr><td>_other_</td><td>Contributors</td><td>All new development occurs in named branches. These will be merged into other topic-specific branches or into develop.</td></tr>
</table>

The following steps should be taken when contributing code.
1. Determine the branch to which your code should apply.
The following steps should be taken when contributing code.

1. Determine the branch to which your code should apply.
* Bug fixes for the existing release should start from the _version-x.y_ branch.
* Bug fixes that don't affect the current release should start from _develop_.
* New features should start from _develop_ or a sub-branch.
* New features should start from _develop_ or a sub-branch.

2. If you have a bug fix, create an Issue on the issue tracker. If you are fixing a bug on the _develop_ branch and want it applied to prior stable releases as a patch, label the issue with ```needs-patch```.
3. ```checkout``` the appropriate branch. Pull to the Head.
4. Create and checkout a new branch for your changes. ```git checkout -b <new branch name>```.
5. Make your changes and commit them to your branch with frequent, descriptive commits.
5. Make your changes and commit them to your branch with frequent, descriptive commits.
6. Build SolarPILOT and test it to make sure your code works as expected (see [below](#test-protocol)).
7. ```git push origin <new branch name>``` to publish your branch.
8. On the [repository](https://github.com/NREL/SolarPILOT) web page, create a pull request for your new branch.
* Specify the target branch according to the selection from step (1) above.
* Specify the target branch according to the selection from step (1) above.
* Make sure to fully comment your pull request.
* The project admins will review your pull request and solicit discussion if any issues arise. If your pull request is accepted, the branch will be deleted, and you can delete your local copy of the branch. If the request is not accepted, please review the discussion to determine and resolve any issues.
* The project admins will review your pull request and solicit discussion if any issues arise. If your pull request is accepted, the branch will be deleted, and you can delete your local copy of the branch. If the request is not accepted, please review the discussion to determine and resolve any issues.

### Resources for Learning GitHub

Expand All @@ -76,13 +78,13 @@ If you are new to GitHub, you can find helpful articles to help you learn how it

### Test Protocol

We are in the process of setting up a Google Test framework for testing your contribution to ensure that it does not cause any problems with the software.
We are in the process of setting up a Google Test framework for testing your contribution to ensure that it does not cause any problems with the software.

For now, you can help to ensure that your code works with the rest of SolarPILOT by:

1. Compiling SolarPILOT with your contribution for Windows, Mac, and Linux.

3. Fixing any compiler warning messages.
2. Fixing any compiler warning messages.

3. Running the compiled program with several configurations.

Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2018 Alliance for Sustainable Energy, LLC
# Copyright 2018 Alliance for Sustainable Energy, LLC

NOTICE: This software was developed at least in part by Alliance for Sustainable Energy, LLC (“Alliance”) under Contract No. DE-AC36-08GO28308 with the U.S. Department of Energy and the U.S. The Government retains for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in the software to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so.

Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,27 @@ The desktop version of SolarPILOT for Windows or Linux builds from the following

* This repository, **SolarPILOT**, provides the user interface to assign values to inputs of the computational modules, run the modules in the correct order, and display calculation results. It also includes tools for editing LK scripts, viewing field layout and receiver flux map data, and performing multi-dimensional system optimization.

# Quick Steps for Building SolarPILOT
## Quick Steps for Building SolarPILOT

For detailed build instructions see the [wiki](https://github.com/NREL/SolarPILOT/wiki), with specific instructions for:

* [Windows](https://github.com/NREL/SolarPILOT/wiki/Windows-Build)
* [Linux](https://github.com/NREL/SolarPILOT/wiki/Linux-Build)
* [Windows](https://github.com/NREL/SolarPILOT/wiki/Windows-Build)
* [Linux](https://github.com/NREL/SolarPILOT/wiki/Linux-Build)

These are the general quick steps you need to follow to set up your computer for developing SolarPILOT:

1. Set up your development tools:

* Windows: Visual Studio 2017 Community or other editions available at https://www.visualstudio.com/.
* Linux: g++ compiler available at http://www.cprogramming.com/g++.html or as part of the Linux distribution.
* Windows: Visual Studio 2017 Community or other editions available [here](https://www.visualstudio.com/).
* Linux: g++ compiler available [here](http://www.cprogramming.com/g++.html) or as part of the Linux distribution.

2. Download the wxWidgets 3.1.1 source code for your operating system from https://www.wxwidgets.org/downloads/.
2. Download the [wxWidgets 3.1.1 source code](https://www.wxwidgets.org/downloads/) for your operating system.

3. Build wxWidgets.

5. In Windows, create the WXMSW3 environment variable on your computer to point to the wxWidgets installation folder, or Linux, create the dynamic link `/usr/<USERNAME>/local/bin/wx-config-3` to point to `/path/to/wxWidgets/bin/wx-config`.
4. In Windows, create the WXMSW3 environment variable on your computer to point to the wxWidgets installation folder, or Linux, create the dynamic link `/usr/<USERNAME>/local/bin/wx-config-3` to point to `/path/to/wxWidgets/bin/wx-config`.

6. As you did for wxWidgets, for each of the following projects, clone (download) the repository, build the project, and then (Windows only) create an environment variable pointing to the project folder. Build the projects in the following order, and assign the environment variable for each project before you build the next one:
5. As you did for wxWidgets, for each of the following projects, clone (download) the repository, build the project, and then (Windows only) create an environment variable pointing to the project folder. Build the projects in the following order, and assign the environment variable for each project before you build the next one:

<table>
<tr><th>Project</th><th>Repository URL</th><th>Windows Environment Variable</th></tr>
Expand All @@ -51,12 +51,12 @@ These are the general quick steps you need to follow to set up your computer for
<tr><td>SolarPILOT</td><td>https://github.com/NREL/SolarPILOT</td><td></td></tr>
</table>

# Contributing
## Contributing

If you would like to report an issue with SolarPILOT or make a feature request, please let us know by adding a new issue on the [issues page](https://github.com/NREL/SolarPILOT/issues).

If you would like to submit code to fix an issue or add a feature, you can use GitHub to do so. Please see [Contributing](CONTRIBUTING.md) for instructions.

# License
## License

SolarPILOT's open source code is copyrighted by the Alliance for Sustainable Energy and licensed under a [mixed MIT and GPLv3 license](LICENSE.md). It allows for-profit and not-for-profit organizations to develop and redistribute software based on SolarPILOT under terms of an MIT license and requires that research entities including national laboratories, colleges and universities, and non-profit organizations make the source code of any redistribution publicly available under terms of a GPLv3 license.

0 comments on commit 49184f5

Please sign in to comment.