From f33ddce9267f934332653d78b775a3d29552151b Mon Sep 17 00:00:00 2001 From: Matt Strapp Date: Tue, 6 Aug 2024 09:20:36 -0500 Subject: Format all documentation Signed-off-by: Matt Strapp --- CMakeLists.txt | 2 +- Cargo.toml | 6 +++++- README.md | 2 +- docs/C.md | 15 +++++++++++---- docs/Go.md | 10 +++++++--- docs/Python.md | 12 ++++++++---- docs/Rust.md | 14 +++++++++++--- locusts.go | 2 +- meson.build | 2 +- ocusts.pc.in | 2 +- pyproject.toml | 16 +++++++++++++++- src/locusts.c | 1 - 12 files changed, 62 insertions(+), 22 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 6442c4f..ecdfbcf 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,5 +1,5 @@ cmake_minimum_required(VERSION 3.14) -project(libocusts VERSION 1.0.0 DESCRIPTION "A completely normal C library" LANGUAGES C) +project(libocusts VERSION 1.0.0 DESCRIPTION "A C library that introduces locusts into your codebase" LANGUAGES C) include(GNUInstallDirs) diff --git a/Cargo.toml b/Cargo.toml index 1053ed3..4d16b2d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,10 @@ [package] name = "locusts" version = "1.0.0" -edition = "2021" +description = "A Rust library that introduces locusts into your codebase" +authors = ["Matt Strapp "] +readme = "docs/Rust.md" +license = "0BSD" +edition = "2015" [dependencies] diff --git a/README.md b/README.md index a9a06f6..c43a2d8 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ We here at Locusts-R-Us have developed a series of libraries for all sorts of programming languages to introduce locusts in all sorts of codebases. ## Currently Supported Languages + - [C/C++](./docs/C.md) - [Rust](./docs/Rust.md) - [Go](./docs/Go.md) - [Python](./docs/Python.md) - diff --git a/docs/C.md b/docs/C.md index 27ea047..0ab3aef 100644 --- a/docs/C.md +++ b/docs/C.md @@ -1,36 +1,42 @@ # liboCusts ## Description + liboCusts is a library that provides a way to introduce locusts into your code. Why would you want to do that? I don't know. ## Example + ```c #include "locusts.h" int main(void) { - introduce_locusts(); - /* Locusts are now in your codebase! */ - return 0; + introduce_locusts(); + /* Locusts are now in your codebase! */ + return 0; } ``` ## Building + Multiple build systems are supported. ### Meson + ```sh meson setup builddir --buildtype=release meson compile -C builddir ``` ### CMake + ```sh cmake -S . -B build cmake --build build ``` ### Autoconf + ```sh autoreconf -fi ./configure @@ -38,4 +44,5 @@ make ``` ## License -This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. \ No newline at end of file + +This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. diff --git a/docs/Go.md b/docs/Go.md index 6532847..87813d1 100644 --- a/docs/Go.md +++ b/docs/Go.md @@ -1,26 +1,30 @@ # Locusts ## Description + Locusts is a library that provides a way to introduce locusts into your code. Why would you want to do that? I don't know. ## Installation + ```sh go get github.com/locusts-r-us/locusts ``` ## Example + ```go package main import "github.com/locusts-r-us/locusts" func main() { - locusts.IntroduceLocusts() - /* Locusts are now in your codebase! */ + locusts.IntroduceLocusts() + // Locusts are now in your codebase! } ``` ## License -This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. \ No newline at end of file + +This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. diff --git a/docs/Python.md b/docs/Python.md index 768ed33..6d01754 100644 --- a/docs/Python.md +++ b/docs/Python.md @@ -1,26 +1,30 @@ # locusts-r-us ## Description + locusts-r-us is a library that provides a way to introduce locusts into your code. Why would you want to do that? I don't know. ## Installation + ```sh pip install locusts-r-us ``` ## Example + ```python import locusts def main(): - locusts.introduce_locusts() - # Locusts are now in your codebase! + locusts.introduce_locusts() + # Locusts are now in your codebase! if __name__ == "__main__": - main() + main() ``` ## License -This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. \ No newline at end of file + +This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. diff --git a/docs/Rust.md b/docs/Rust.md index 11f232d..b01a943 100644 --- a/docs/Rust.md +++ b/docs/Rust.md @@ -1,29 +1,37 @@ # locusts ## Description + locusts is a library that provides a way to introduce locusts into your code. Why would you want to do that? I don't know. ## Installation + Add this to your `Cargo.toml`: + ```toml [dependencies] locusts = "1" ``` + or + ```sh cargo add locusts ``` ## Example + ```rust use locusts; fn main() { - locusts::introduce_locusts(); - /* Locusts are now in your codebase! */ + locusts::introduce_locusts(); + // Locusts are now in your codebase! } ``` + ## License -This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. \ No newline at end of file + +This project is licensed under the BSD Zero Clause License. See the [LICENSE](../LICENSE) file for details. diff --git a/locusts.go b/locusts.go index 3c7204a..89c7764 100644 --- a/locusts.go +++ b/locusts.go @@ -1,4 +1,4 @@ -// Package locusts is a completely normal Go library. +// Package locusts introduces locusts into your codebase. package locusts // IntroduceLocusts is a function that introduces locusts into your codebase. diff --git a/meson.build b/meson.build index 6111db9..da41bfa 100644 --- a/meson.build +++ b/meson.build @@ -11,7 +11,7 @@ project_dep =declare_dependency(include_directories: includes) install_headers(header) pkg = import('pkgconfig') -pkg.generate(lib, description: 'A completely normal C library') +pkg.generate(lib, description: 'A C library that introduces locusts into your codebase') if not meson.is_subproject() test( diff --git a/ocusts.pc.in b/ocusts.pc.in index 41d0ce0..22362f7 100644 --- a/ocusts.pc.in +++ b/ocusts.pc.in @@ -3,7 +3,7 @@ includedir=@includedir@ libdir=@libdir@ Name: ocusts -Description: A completely normal C library +Description: A C library that introduces locusts into your codebase Version: @VERSION@ Libs: -L${libdir} -locusts Cflags: -I${includedir} diff --git a/pyproject.toml b/pyproject.toml index 7fd26b9..cf963cc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,3 +1,17 @@ [build-system] requires = ["setuptools"] -build-backend = "setuptools.build_meta" \ No newline at end of file +build-backend = "setuptools.build_meta" + +[project] +name = "locusts-r-us" +version = "1.0.0" +authors = [ + { name = "Matt Strapp", email = "matt+locusts@mattstrapp.net"} +] +description = "A Python package that introduces locusts into your codebase" +readme = "docs/Python.md" +classifiers = [ + "Programming Language :: Python", + "License :: OSI Approved :: Zero-Clause BSD (0BSD)", + "Operating System :: OS Independent" +] \ No newline at end of file diff --git a/src/locusts.c b/src/locusts.c index 84ff437..806157a 100644 --- a/src/locusts.c +++ b/src/locusts.c @@ -1,4 +1,3 @@ #include "locusts.h" void introduce_locusts(void) { return; } - -- cgit v1.2.3