diff --git a/docs/faq.md b/docs/faq.md index 4a18aa1..0090c75 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,3 +1,46 @@ # FAQ -FAQ coming soon... \ No newline at end of file +
+What if I don't have make installed on my machine? +
+You can refer to the Makefile. +Instead of running a command like make run, you can run the command below it: poetry run python src/server.py +
+
+ +
+What do I do if the linter fails? +
+If the linter fails, you can run make format, which may fix the issues for you! If not, it will tell you +what needs to be fixed in the output. +
+
+ +
+What do I do if pytest fails? +
+If pytest fails, make sure you haven't broken anything unintentionally. Often, new changes in code will result in the unit tests breaking. Functions may now be returning different values/types which the tests do not expect. Please, try to debug any tests you may have broken! +
+
+ +
+The project doesn't work on my machine. What should I do? +
+cli-surf is a new project, and things break. If you come across any bugs, please submit an issue! +
+
+ +
+What is the purpose of this project? +
+I had a small spare monitor that could only display a terminal screen, so I used it to display the weather via wttr.in. I like to surf, +and figured it would be useful to display surf data along with the weather. That is where I got the idea for cli-surf! +
+
+ +
+I have a question about contributing. +
+Please refer to the contributing file, or ask a question on the Discord/Discussions page. +
+
\ No newline at end of file