Merge pull request #24 from core-coin/updates/readme-01

Readme updates

Author: rastislavcore

.gitignore

@@ -4,4 +4,31 @@ CMakeCache.txt
 *.cmake
 Makefile
 gxminer
-bazel-*
+bazel-*
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

LICENSE

@@ -1,7 +1,7 @@
 BSD 3-Clause License
 
 Copyright (c) 2019, Command M
-Copyright (c) 2020, CORE FOUNDATION
+Copyright (c) 2020, CORE Foundation
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,10 +1,10 @@
-# go-randomx
+# Go-randomy
 
-This is a binding for Random-X based algorithms.
+This is a binding for Random-Y based algorithms.
 
 Do NOT use go mod import this.
 
-**NOTICE**: For better go.mod experience, like direcly import go-randomx dep through `go get` or `go build`, check the https://github.com/core-coin/RandomY and https://github.com/core-coin/go-randomx and their github actions.
+For better go.mod experience, like directly import go-randomy dep through `go get` or `go build`, check the https://github.com/core-coin/RandomY and https://github.com/core-coin/go-randomy and their GitHub actions.
 
 ## Algorithms
 
@@ -19,7 +19,7 @@ Do NOT use go mod import this.
 
 ### Windows
 
-Firstly download and install the msys2, then open and install the following components:
+1. Download and install the msys2, then open and install the following components:
 
 Take msys2's pacman for example
 
@@ -28,50 +28,50 @@ pacman -Syu
 pacman -S git mingw64/mingw-w64-x86_64-go mingw64/mingw-w64-x86_64-gcc mingw64/mingw-w64-x86_64-cmake mingw64/mingw-w64-x86_64-make
 ```
 
-Secondly clone this repo to your project folder
-```
+2. Clone this repo to your project folder
+
+```bash
 cd MyProject
-git clone https://github.com/core-coin/go-randomx
+git clone https://github.com/core-coin/go-randomy
 ```
 
-And then run `./build.sh` to auto compile official random-x code
+3. Run `./build.sh` to auto compile official random-y code
+
 ```bash
-# clone and compile RandomX source code into librandomx
-./build random-x # random-x can be replaced with random-xl random-arq random-wow
+# clone and compile RandomY source code into librandomy
+./build random-y # random-y can be replaced with random-xl random-arq random-wow
 ```
 
-Finally you can using the package as your internal one.
+4. You can use the package as your internal one.
 
-Directly using it with `import "github.com/MyProject/go-randomx"` and then `randomx.AllocCache()` etc.
+Directly using it with `import "github.com/MyProject/go-randomy"` and then `randomy.AllocCache()` etc.
 
 ### Linux
 
-Take Ubuntu for example
-
-Download the latest go from [here](https://golang.org/dl/) and then install it following [this instruction](https://golang.org/doc/install#tarball)
+1. Download the latest go from [web](https://golang.org/dl/) and then install it following [this instructions](https://golang.org/doc/install#tarball).
 
 ```bash
 sudo apt update && sudo apt upgrade
 sudo apt install git cmake make gcc build-essential
 ```
 
-Secondly clone this repo to your project folder
+2. Clone this repo to your project folder.
 
 ```
 cd MyProject
-git clone https://github.com/core-coin/go-randomx
+git clone https://github.com/core-coin/go-randomy
 ```
 
-And then run `go generate` to auto compile official random-x code
+3. Run `go generate` to auto compile official random-y code.
 
 ```bash
-# clone and compile RandomX source code into librandomx
-./build random-x # random-x can be replaced with random-xl random-arq random-wow
+# clone and compile RandomY source code into librandomy
+./build random-y # random-y can be replaced with random-xl random-arq random-wow
 ```
 
-Finally you can using the package as your internal one.
+4. You can using the package as your internal one.
 
-Directly using it with `import "github.com/myname/my-project/go-randomx"` and then start the functions like `randomx.AllocCache()` etc.
+Directly using it with `import "github.com/myname/my-project/go-randomy"` and then start the functions like `randomy.AllocCache()` etc.
 
 ## License