From f851b7f5c33fb5f84f0f60ea5f3ec831c37c42fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Breno=20Brand=C3=A3o?= <87045222+ukaase@users.noreply.github.com> Date: Tue, 10 Jan 2023 19:40:29 -0300 Subject: [PATCH 1/2] add quickstart for beginners --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 62a6bdc..738c153 100644 --- a/README.md +++ b/README.md @@ -27,16 +27,48 @@ On Mac, you can use homebrew: brew install portaudio -### Installation +### Installation [Outdated] The `go get` command will automatically fetch the dependencies listed above, compile the binary and place it in your `$GOPATH/bin` directory. go get github.com/fogleman/nes + >since Go 1.8, you don't need to set your GOPATH or GOROOT. + >GOPATH by default is under your user/home directory. + +### Quick Start + git clone https://github.com/fogleman/nes.git + cd nes/ + go mod tidy + go build -o nesexe + ./nesexe [rom_file|rom_directory] + +### Error case +>golang version at least 1.18 + +>go mod tidy provides all ![Dependencies](https://github.com/ukaase/nes/preview/master/README.md#dependencies) required to wrappers of gl and glfw. +>but to use theses wrappers you will need the libraries of gl and glfw that you can install in your OS system following theses commands + + +[X11 and Glfw] + + sudo apt install libxcursor-dev + sudo apt install libxinerama-dev + sudo apt install libxi-dev + sudo apt install libx11-dev + sudo apt install libglu1-mesa-dev + sudo apt install libxrandr-dev + + +[Glut] + + sudo apt-get install freeglut3-dev + + ### Usage - nes [rom_file|rom_directory] + ./nesexe [rom_file|rom_directory] 1. If no arguments are specified, the program will look for rom files in the current working directory. From 670d3fe026e1b7668aecb219c50c36de58e5649e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Breno=20Brand=C3=A3o?= <87045222+ukaase@users.noreply.github.com> Date: Tue, 10 Jan 2023 19:43:15 -0300 Subject: [PATCH 2/2] quickstart for beginners --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 738c153..3c52a2c 100644 --- a/README.md +++ b/README.md @@ -47,11 +47,11 @@ compile the binary and place it in your `$GOPATH/bin` directory. ### Error case >golang version at least 1.18 ->go mod tidy provides all ![Dependencies](https://github.com/ukaase/nes/preview/master/README.md#dependencies) required to wrappers of gl and glfw. +>go mod tidy provides all Dependencies required to wrappers of gl and glfw. >but to use theses wrappers you will need the libraries of gl and glfw that you can install in your OS system following theses commands -[X11 and Glfw] +[X11 & Glfw] sudo apt install libxcursor-dev sudo apt install libxinerama-dev @@ -61,10 +61,10 @@ compile the binary and place it in your `$GOPATH/bin` directory. sudo apt install libxrandr-dev -[Glut] +[Glut & PortAuido] sudo apt-get install freeglut3-dev - + sudo apt-get install portaudio19-dev ### Usage