Idaho Fish and Game PopR User Manual

Documentation for the Idaho PopR website
View The Book »

Report A Bug · Request A Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Built With

• bookdown

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

The following must be installed to contribute to the user manual:

• git
• RStudio (> 1.0.0)
• TinyTeX (Only needed for pdf format)
• bookdown package

install.packages("bookdown")

Installation

1. Clone the repo
   • RStudio:
     1. File -> New Project or Create Project button
     2. Select Version Control
     3. Select Git
     4. Repository URL: https://github.com/ericnewkirk/IDFG_user_manual.git
     5. Click Create Project
   • GitHub Desktop Client
     1. File -> Clone Repository
     2. URL tab
     3. URL: https://github.com/ericnewkirk/IDFG_user_manual.git
     4. Click Clone
   • Git via command prompt

          git clone https://github.com/ericnewkirk/IDFG_user_manual.git 

2. Open the .rproj file inside the repo using RStudio

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

1. Clone the repository

2. Create a new branch off Develop

3. Switch to the new branch using RStudio, GitHub Desktop, or command prompt

4. Commit your changes

5. Push your commits to GitHub

6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Eric Newkirk - eric.newkirk@speedgoat.io

Project Link: IDFG User Manual

Acknowledgements

• Speedgoat
• Idaho Fish and Game