From 891f07aa0a92bc2a67e975a3cabcdd27b355199d Mon Sep 17 00:00:00 2001 From: Franklalalala <1660810667@qq.com> Date: Sat, 1 Apr 2023 23:20:55 +0800 Subject: [PATCH] Update README.md --- README.md | 48 +++++++++++++++++++++++++++++------------------- 1 file changed, 29 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 424db90..ed8e67c 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,3 @@ -# File Comments -## File differences with source library codes -Changed some files from source (https://pallini.di.uniroma1.it/index.html) Version 2.7R1 (MAY 19 2019): -- naututil.h: - For msvc use, change `` to `"times.h"` and `times.c` with Macro defined for arch choice. -- gtools.h: - For msvc use, change `` to `"wait.h"` -- showg.c: - Add a compiler choice `ASLIB` - -# Code structure and function enhancement information -- New `CMakeLists.txt` instead of `makefile`. -- All `boolean` type code are changed to `_Boolean` -- Change a Macro in `nauty.h`: - `FIRSTBITNZ(x)` to `msc_bsr_xx(x)` where call `unsigned long p` instead of `unsigned long *p` - -File and `wait.h` is from `https://github.com/win32ports`, By MIT License. Some necessary changed is with them. -File `times.h` is used for necessary function and types. - # Compile instruction ## Before compiling @@ -66,6 +47,35 @@ Otherwise, one needs to prepare a compiler and cmake that meets requirements. Se The compile line is the same as above. +# File Comments + +## File differences with source library codes + +Changed some files from [source](https://pallini.di.uniroma1.it/index.html) Version 2.7R1 (MAY 19 2019): + +- naututil.h: + For msvc use, change `` to `"times.h"` and `times.c` with Macro defined for arch choice. +- gtools.h: + For msvc use, change `` to `"wait.h"` +- showg.c: + Add a compiler choice `ASLIB` + +# Code structure and function enhancement information + +- New `CMakeLists.txt` instead of `makefile`. +- All `boolean` type code are changed to `_Boolean` +- Change a Macro in `nauty.h`: + `FIRSTBITNZ(x)` to `msc_bsr_xx(x)` where call `unsigned long p` instead of `unsigned long *p` + +File and `wait.h` is from `https://github.com/win32ports`, By MIT License. Some necessary changed is with them. +File `times.h` is used for necessary function and types. + +Additionally, this project conducted several changes comparing to the original modification in [saltball/usenauty (github.com)](https://github.com/saltball/usenauty). + +* The step and random mode are created on top of the base mode. +* Code structures are refactored to enable some suitable API. +* Bugs fixed for compilation in the Linux platform. (credit to @saltball) + # Other info This repo is try to use `nauty` for some chemical research and create some new API. It's still on going. Original License is [COPYRIGHT](libnauty/COPYRIGHT)