Skip to content

Commit

Permalink
Simplify README
Browse files Browse the repository at this point in the history
The UCI protocol is rather technical and has little value in our README. Instead
it should be explained in our wiki. "Contributing" is moved above "Compiling
Pikafish" to make it more prominent.

Also move the CONTRIBUTING.md into the root directory and include it in the
distributed artifacts/releases.

No functional change
  • Loading branch information
PikaCat-OuO committed Sep 7, 2023
1 parent 6acac2a commit e9a2871
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 34 deletions.
1 change: 1 addition & 0 deletions .github/workflows/pikafish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ jobs:
${{ matrix.config.name }}/*
Wiki
AUTHORS
CONTRIBUTING.md
Copying.txt
README.md
Top CPU Contributors.txt
Expand Down
File renamed without changes.
57 changes: 23 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,40 +60,9 @@ This distribution of Pikafish consists of the following files:
* a file with the .nnue extension, storing the neural network for the NNUE
evaluation.

## The UCI protocol

The [Universal Chess Interface][uci-link] (UCI) is a standard text-based protocol
used to communicate with a chess engine and is the recommended way to do so for
typical graphical user interfaces (GUI) or chess tools. Pikafish implements the
majority of its options.

Developers can see the default values for the UCI options available in Pikafish
by typing `./pikafish uci` in a terminal, but most users should typically use a
xiangqi GUI to interact with Pikafish.

For more information on UCI or debug commands, see our [documentation][wiki-commands-link].

## Compiling Pikafish

Pikafish has support for 32 or 64-bit CPUs, certain hardware instructions,
big-endian machines such as Power PC, and other platforms.

On Unix-like systems, it should be easy to compile Pikafish directly from the
source code with the included Makefile in the folder `src`. In general, it is
recommended to run `make help` to see a list of make targets with corresponding
descriptions.

```
cd src
make -j build ARCH=x86-64-modern
```

Detailed compilation instructions for all platforms can be found in our
[documentation][wiki-compile-link].

## Contributing

__See [Contributing Guide](./.github/CONTRIBUTING.md).__
__See [Contributing Guide](./CONTRIBUTING.md).__

### Donating hardware

Expand All @@ -117,6 +86,26 @@ Discussions about Pikafish take place these days mainly in the Pikafish
[Discord server][discord-link]. This is also the best place to ask questions
about the codebase and how to improve it.


## Compiling Pikafish

Pikafish has support for 32 or 64-bit CPUs, certain hardware instructions,
big-endian machines such as Power PC, and other platforms.

On Unix-like systems, it should be easy to compile Pikafish directly from the
source code with the included Makefile in the folder `src`. In general, it is
recommended to run `make help` to see a list of make targets with corresponding
descriptions.

```
cd src
make -j build ARCH=x86-64-modern
```

Detailed compilation instructions for all platforms can be found in our
[documentation][wiki-compile-link].
the [UCI commands][wiki-uci-link] supported by Pikafish.

## Terms of use

### GNU General Public License version 3
Expand Down Expand Up @@ -163,7 +152,7 @@ also be made available under GPL v3.
[website-link]: https://pikafish.org
[website-blog-link]: https://pikafish.org/
[wiki-link]: https://github.com/official-pikafish/Pikafish/wiki
[wiki-usage-link]: https://github.com/official-pikafish/Pikafish/wiki/Download-and-usage
[wiki-compile-link]: https://github.com/official-pikafish/Pikafish/wiki/Compiling-from-source
[wiki-commands-link]: https://github.com/official-pikafish/Pikafish/wiki/Commands
[wiki-commands-link]: https://github.com/official-pikafish/Pikafish/wiki/UCI-&-Commands
[wiki-usage-link]: https://github.com/official-pikafish/Pikafish/wiki/Download-and-usage
[worker-link]: https://github.com/xyztnecniV/yolo
1 change: 1 addition & 0 deletions src/nnue/features/half_ka_v2_hm.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
#ifndef NNUE_FEATURES_HALF_KA_V2_HM_H_INCLUDED
#define NNUE_FEATURES_HALF_KA_V2_HM_H_INCLUDED

#include <array>
#include <cstdint>

#include "../../misc.h"
Expand Down

0 comments on commit e9a2871

Please sign in to comment.