Skip to content

Commit

Permalink
README: Add section on using this as a base for AoC
Browse files Browse the repository at this point in the history
  • Loading branch information
nihas101 committed Dec 1, 2023
1 parent a9d2a50 commit 1df7c5d
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,30 @@
# Advent of Code 2023
A repository containing my solutions to the [Advent of code 2023](https://adventofcode.com)
A repository containing my solutions to the [Advent of code 2023](https://adventofcode.com/2023)

## Requirements
The solutions are written in [Clojure](https://clojure.org).
The solutions are written in [Clojure](https://clojure.org). [Leningen](https://leiningen.org/) can be used to execute the code within this project to e.g. run tests on the solutions.

## Solutions
The solutions are located in `src/advent_of_code_2023/`. The solutions for day XX are found in file `dayXX.clj`. The corresponding tests are found in files named `test/advent_of_code_2023/dayXX_test.clj`.
The solutions are located in `src/advent_of_code_2023/`. The solutions for day XY are found in file `dayXY.clj`. The corresponding tests are found in files named `test/advent_of_code_2023/dayXY_test.clj`. Input files are stored in `resources/dayXY.txt`


# Using This Repository as a Base

## Useful Links
If you are a newcomer to Clojure, consider checking out these links:
- [Clojure For the Brave and True](https://www.braveclojure.com/)
- [Clojure Docs](https://clojuredocs.org/)
- [Clojure Cheatsheet](https://clojure.org/api/cheatsheet)
- [Clojure Style Guide](https://guide.clojure.style/)
- [An introductory, self study functional programming course](https://github.com/pkoerner/functional-programming-course)

# Helpful Tools
If you plan to use this as a base project for your own solutions also consider the following plugins for leiningen and other helpful assorted tools:
- [kibit](https://github.com/clj-commons/kibit) to discover idiomatic functions for constructs you are using
- [clj-kondo](https://github.com/clj-kondo/clj-kondo): A static analyzer and linter
- [eastwood](https://github.com/jonase/eastwood) for linting
- [lein-auto](https://github.com/weavejester/lein-auto) to automatically run tasks on file changes
- [eftest](https://github.com/weavejester/eftest) for prettier test output

## License

Expand Down

0 comments on commit 1df7c5d

Please sign in to comment.