From e140783f46f6de15f65ec0df18cd7156d3cc4604 Mon Sep 17 00:00:00 2001 From: Xuan Sang LE Date: Tue, 27 Feb 2018 14:29:24 +0100 Subject: [PATCH 1/4] Update README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index a052bf7..35634a1 100644 --- a/README.md +++ b/README.md @@ -9,4 +9,25 @@ A demo of the webOS is available at my page [https://os.lxsang.me](https://os.l ![Screenshot](screenshot.png "Screenshot") +## Build + +Note that this is only the client API, to make it work for your application, you need to implement all the system calls in core/handlers/RemoteHandler.coffee using a server side scripting language (e.g. PHP). I'm planning to release an API documentation which describes what need to be sent and what will be returned for each system call in near future (i'm kind of very busy right now :) ). + +I'm a big fan of Make system, so i use it as a build system for all of my projects. So, to build AntOS: +1. You need to have *make* installed. Then since most of the API is written in Coffee script, you will need it to be installed too. +2. Edit the BUILDDIR variable in the Makefile file to point to where you want to put the built API +3. Tpye `make` then you are good to go. + +It you have any problem, please contact me or open an issue, i'll try to response ASAP. + +## Licence + +Copyright 2017-2018 Xuan Sang LE + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + From af39e8b6ba48f47994ce1b3dee3e5b00aff92d1b Mon Sep 17 00:00:00 2001 From: Xuan Sang LE Date: Tue, 27 Feb 2018 14:30:28 +0100 Subject: [PATCH 2/4] Create LICENSE --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0362eb5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Xuan Sang LE + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From 2ad6c6823ce261aa0907c15a00dddaaa548cbc28 Mon Sep 17 00:00:00 2001 From: Xuan Sang LE Date: Tue, 27 Feb 2018 14:31:38 +0100 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 35634a1..4164c3c 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ A demo of the webOS is available at my page [https://os.lxsang.me](https://os.l Note that this is only the client API, to make it work for your application, you need to implement all the system calls in core/handlers/RemoteHandler.coffee using a server side scripting language (e.g. PHP). I'm planning to release an API documentation which describes what need to be sent and what will be returned for each system call in near future (i'm kind of very busy right now :) ). -I'm a big fan of Make system, so i use it as a build system for all of my projects. So, to build AntOS: +I'm a big fan of the Make system, so i use it as a build system for all of my projects. So, to build AntOS: 1. You need to have *make* installed. Then since most of the API is written in Coffee script, you will need it to be installed too. 2. Edit the BUILDDIR variable in the Makefile file to point to where you want to put the built API 3. Tpye `make` then you are good to go. From e17eca0ed6a7d7040255e8489cd2125a304ceae2 Mon Sep 17 00:00:00 2001 From: Xuan Sang LE Date: Tue, 27 Feb 2018 14:40:23 +0100 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4164c3c..5b12f8a 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Note that this is only the client API, to make it work for your application, you I'm a big fan of the Make system, so i use it as a build system for all of my projects. So, to build AntOS: 1. You need to have *make* installed. Then since most of the API is written in Coffee script, you will need it to be installed too. 2. Edit the BUILDDIR variable in the Makefile file to point to where you want to put the built API -3. Tpye `make` then you are good to go. +3. Type `make` then you are good to go. It you have any problem, please contact me or open an issue, i'll try to response ASAP.