From dce5dd5f474b6dce5110184f2588e7ac91f980bb Mon Sep 17 00:00:00 2001 From: InversionSpaces Date: Tue, 16 May 2023 17:32:02 +0000 Subject: [PATCH] Removed readme --- README.md | 64 ------------------------------------------------------- 1 file changed, 64 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 7899946d..00000000 --- a/README.md +++ /dev/null @@ -1,64 +0,0 @@ -# Aqua - -[![release](https://github.com/fluencelabs/aqua/actions/workflows/release.yml/badge.svg)](https://github.com/fluencelabs/aqua/actions/workflows/release.yml) -[![npm](https://img.shields.io/npm/v/@fluencelabs/aqua)](https://www.npmjs.com/package/@fluencelabs/aqua) - -[Aqua](https://fluence.dev/docs/aqua-book/introduction) is an open-source language for distributed workflow coordination in p2p networks. Aqua programs are executed on many peers, sequentially or in parallel, forming a single-use coordination network. Applications are turned into hostless workflows over distributed function calls, which enables various levels of decentralization: from handling by a limited set of servers to complete peer-to-peer architecture by connecting user devices directly. Aqua is the core of the [Fluence](https://fluence.network/) protocol and a framework for internet or private cloud applications. - - -## Installation and Usage - -The easiest way to use Aqua is to download the latest build from npm: [@fluencelabs/aqua](https://www.npmjs.com/package/@fluencelabs/aqua). - -```bash -npm i -g @fluencelabs/aqua -aqua --input src/aqua --output src/generated -``` - -Input directory should contain files with `.aqua` scripts. - -Other ways of installing Aqua can be found in [INSTALL.md](./INSTALL.md). - - -## Documentation - -Comprehensive documentation and usage examples as well as a number of videos can be found in [Aqua Book](https://fluence.dev/docs/aqua-book/introduction). [Aqua Playground](https://github.com/fluencelabs/aqua-playground) demonstrates how to start writing Aqua and integrate it into a [TypeScript](https://www.typescriptlang.org/) application. Numerous videos are available at our [YouTube channel](https://www.youtube.com/@fluencelabs). - - -## Repository Structure - -- [**api**](./api) - Aqua API for JS - - [aqua-api](./api/aqua-api) - Scala sources - - [aqua-api-npm](./api/aqua-api-npm) - JS project - - [aqua-api-example](./api/aqua-api-example) - usage example -- [**aqua-run**](./aqua-run) - Aqua API to run functions -- [**backend**](./backend) - compilation backend interface - - [backend/air](./backend/air) - generates AIR code from the middle-end model - - [backend/ts](./backend/ts) - generates AIR code and TypeScript wrappers for use with [Fluence JS]( https://github.com/fluencelabs/fluence-js) SDK -- [**cli**](./cli) - CLI interface - - [cli](./cli/cli) - Scala sources - - [cli-npm](./cli/cli-npm) - JS project -- [**compiler**](./compiler) - compiler as a pure function made from _linker_, _semantics_ and _backend_ -- [**model**](./model) - middle-end, internal representation of the code, optimizations and transformations - - [transform](./model/transform) - optimizations and transformations, converting model to the result, ready to be rendered - - [test-kit](./model/test-kit) - tests and test helpers for the model and transformations -- [**linker**](./linker) - checks dependencies between modules, builds and combines an abstract dependencies tree -- [**parser**](./parser) - parser, takes source text and produces a source AST -- [**semantics**](./semantics) - rules to convert source AST into the model -- [**types**](./types) - data types, arrows, stream types definitions and variance - - -## Support - -Please, file an [issue](https://github.com/fluencelabs/aqua/issues) if you find a bug. You can also contact us at [Discord](https://discord.com/invite/5qSnPZKh7u) or [Telegram](https://t.me/fluence_project). We will do our best to resolve the issue ASAP. - - -## Contributing - -Any interested person is welcome to contribute to the project. Please, make sure you read and follow some basic [rules](./CONTRIBUTING.md). - - -## License - -All software code is copyright (c) Fluence Labs, Inc. under the [Apache-2.0](./LICENSE) license. -