diff --git a/README.md b/README.md index 6d8378da..cbf38a59 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Please refer to [Goldman Sachs Developer](https://developer.gs.com/docs/gsquant/ * Python 3.6 or greater * Access to PIP package manager +* Client ID and secret for API access (for institutional clients) ## Installation @@ -19,13 +20,72 @@ Please refer to [Goldman Sachs Developer](https://developer.gs.com/docs/gsquant/ pip install gs-quant ``` +## Development Setup +* 1. Clone the Repository +``` +git clone https://github.com/your-organization/gs-quant.git +cd gs-quant +``` + +* 2. Create a Virtual Environment +``` +python -m venv env +source env/bin/activate # On Windows use `env\Scripts\activate` +``` + +* 3. Install Dependencies +``` +pip install -r requirements.txt +``` + +* 4. Install GS Quant Locally +``` +pip install -e . +``` + +## Building the Project +If the project requires a build step, describe it here. For example: + +``` +# Example build command +python setup.py build +``` + +## Running Tests +To run tests, use the following command: +``` +pytest +``` +Make sure to run tests before submitting any changes. + + +## Contributing +Contributions are welcome! Please follow these guidelines: +1.) Fork the Repository: Use the GitHub interface to fork the repository to your own account. +2.) Create a Branch: Create a feature branch for your changes +``` +git checkout -b feature/your-feature-name +``` + +3.) Commit Your Changes: Write descriptive commit messages. +``` +git commit -m "Add feature X" +``` + +4.) Push to Your Fork: Push your changes to your forked repository. +``` +git push origin feature/your-feature-name +``` + +5.) Submit a Pull Request: Go to the original repository on GitHub and submit a pull request. + +Please see [CONTRIBUTING](CONTRIBUTING.md) for more details. + ## Examples You can find examples, guides and tutorials in the respective folders as well as on [Goldman Sachs Developer](https://developer.gs.com/docs/gsquant/). -## Contributions -Contributions are encouraged! Please see [CONTRIBUTING](CONTRIBUTING.md) for more details. ## Help