Skip to content

bunchofcellulose/aoguide

Repository files navigation

AOGuide

AOGuide is an open-source guide for the Astronomy Olympiad, designed to help participants prepare for the competition. It provides curated resources, explanations, and study materials covering key topics in astronomy and astrophysics.

Features

  • Comprehensive coverage of Astronomy Olympiad topics
  • Easy-to-navigate web interface powered by Hugo
  • Modern, responsive design using the Hextra theme
  • Regularly updated content and resources

Getting Started

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/aoguide.git
    cd aoguide
  2. Install Hugo: Follow the official instructions for your platform.

  3. Update submodules (Hextra theme):

    git submodule update --init --recursive
  4. Run the development server:

    hugo server

    Visit http://localhost:1313 in your browser.

Contributing

Contributions are welcome! To contribute:

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or fix:
    git checkout -b feature/your-feature
  3. Make your changes and commit them with clear messages.
  4. Push your branch to your fork:
    git push origin feature/your-feature
  5. Open a pull request to the main repository.

Contribution Guidelines

  • Please ensure your changes are relevant and improve the project.
  • For major changes, open an issue first to discuss what you would like to change.
  • Follow existing code style and structure.
  • Add documentation or comments where appropriate.
  • Be respectful and constructive in discussions and reviews.

Roadmap

  • Gravitational Waves
  • Compact Stars: Black Holes
  • History & Fate of Universe, flatness problem etc.
  • Evolution of Stars

License

This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Acknowledgements

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •