Skip to content

Commit d983fdb

Browse files
fix(readme): general readme fixes
1 parent 4c15d81 commit d983fdb

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55
<p align="center">
66
<a href="#about">About</a> •
77
<a href="#getting-started">Getting Started</a> •
8-
<a href="#Milestones">Milestones</a>
8+
<a href="#milestones">Milestones</a>
99
</p>
1010
</p>
1111

1212
## About
1313

1414
This is my personal C++ library designed specifically for competitive programming. It contains a variety
1515
of data structures, algorithms, and other utilities commonly used in competitive programming. Each component
16-
of this library is designed to be drop-in-usable—no setup or external dependencies required. The entire
16+
of this library is designed to be drop-in usable—no setup or external dependencies required. The entire
1717
library is designed to have sections that are copy-pasteable into a single file for contest submission.
1818

1919
## Getting Started
2020

21-
Since the core idea of this library is to copy paste sections from it into your own code I recommend
22-
having a local copy of the library in an easy to access location:
21+
Since the core idea of this library is to copy-paste sections from it into your own code I recommend
22+
keeping a local copy of the library in an easy to access location:
2323

2424
```bash
2525
git clone https://github.com/BrandonPacewic/CompetitiveProgramming
@@ -33,12 +33,12 @@ From there you can:
3333

3434
> [!NOTE]
3535
> Additional instructions and support for importing the library and using the test cases is
36-
> planed to be added in the future.
36+
> planned to be added in the future.
3737
3838
## Milestones
3939

40-
As will every single one of my projects, this is still very much a work in progress. The following is a list
41-
of goals I have for this project before I'm truly happy with it, in no particular order:
40+
As with every single one of my projects, this is still very much a work in progress. The following is a list
41+
of goals I have for this project before I consider it to be complete, in no particular order:
4242

4343
| # | Goal | Status |
4444
| :-: | --------------------------------------------------------- | :----: |
@@ -55,15 +55,15 @@ A more detailed description of each goal can be found below:
5555
This is my longest standing project in terms of the initial creation date. As such, the earlier code does
5656
not reflect my current standards. One of the current goals is to revise such code to improve quality.
5757

58-
> [!WARNINg]
58+
> [!NOTE]
5959
> I find the structure of the code in this repository to be quite volatile. I have probably re-written some
60-
> of the algorithms 10+ times. If something doesn't look quite right, it probably isn't.
60+
> of the algorithms 10+ times as this library tends to evolve as I become a better programmer.
61+
> If something doesn't look quite right, it probably isn't.
6162
6263
#### Full Test Coverage
6364

64-
While this library is designed to be used in competitive programming, where tests written in this repository
65-
obviously won't be carried over. There still should be total test coverage this includes copies of various
66-
programming problems that I have used sections of this library to solve.
65+
While this library is meant for competitive programming (where tests don’t carry over), it should still have
66+
full test coverage — including tests derived from problems where I used components of this library to solve them.
6767

6868
#### Performance with Supporting Benchmarks
6969

@@ -80,23 +80,23 @@ structure and implement various key algorithms and data structures.
8080
The *Atomizer* is a tool used to break down the codebase into smaller, more manageable pieces, that can be
8181
retrieved quickly. For example, if you want to use a specific function, say `output_container` to keep things
8282
simple. You can use the *Atomizer* output to retrieve that specific function via a file lookup, `output_container.cpp`.
83-
You can also use any supporting tool you want to pase that file buffer directly inline into your code. Rather than
83+
You can also use any supporting tool you want to paste that file buffer directly inline into your code. Rather than
8484
opening the container header file and copying the specific lines from the file that you need. This will also work
8585
with more complex algorithms that may require an additional data structure to function. For example, if you want to
8686
use Kruskal's algorithm, you can use the *Atomizer* to retrieve the `kruskal.cpp` file which will include the
87-
supporting `DisjointSet` class used within the algorithm. Again resolving you of finding the specific lines of code
87+
supporting `DisjointSet` class used within the algorithm. Again saving you from finding the specific lines of code
8888
within the header file that you need.
8989

9090
#### Full Implementation of the CPH (Competitive Programming Handbook)
9191

92-
The [*Competitive Programming Handbook*]() by Antti Laaksonen is a awesome, all in one, resource for
93-
everything competitive programming. It contains everything from compiling and reading input to sweep line
92+
The [*Competitive Programming Handbook*](https://cses.fi/book/book.pdf) by Antti Laaksonen is an awesome, all in one,
93+
resource for everything competitive programming. It contains everything from compiling and reading input to sweep line
9494
algorithms including convex hulls. Its an eventual goal of mine to fully implement all the algorithms outlined
9595
in the book. This has the added benefit of an *complete* documentation source of all the algorithms in this
9696
library. This is a long term goal and will likely take a while to complete.
9797

9898
> [!NOTE]
99-
> This is my end game goal for this project. When its completed I will consider this project *done* as so far
99+
> This is my endgame for this project. When its completed I will consider this project *done* as so far
100100
> as it will no longer be a major work in progress for me personally. I will still add things here and there
101101
> and work on it when I'm compelled to do so but the core goals of this project will be officially complete.
102102

0 commit comments

Comments
 (0)