Skip to content

Doc update #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EasyCoder #

**_EasyCoder_** is a WordPress or standalone plugin that lets you write highly readable scripts to control the appearance and behavior of your web pages. This is what JavaScript does, but **_EasyCoder_** is a lot easier to learn. Here are its main benefits:
**_EasyCoder_** is a high-level scripting language that lets you write highly readable scripts to control the appearance and behavior of your web pages. This is what JavaScript does, but **_EasyCoder_** is a lot easier to learn. Here are its main benefits:

1. It's quick to write browser applications in **_EasyCoder_**. Website development is faster and sites are more reliable.
1. **_EasyCoder_** scripts are smaller than the corresponding JavaScript and are easy to read by most people, not just by programmers. This matters later on when maintenance is needed and the original programmer may no longer be available.
Expand All @@ -13,6 +13,8 @@
1. **_EasyCoder_** includes a REST server that permits scripts to access resources on demand from the server rather than having them embedded in the page. Resources include scripts, HTML components, CSS and general data, and all can be loaded and unloaded dynamically.
1. **_EasyCoder_** is well suited to the construction of single-page web designs of unlimited size. The memory space occupied by JavaScript remains roughly the same no matter how many scripts and data you load and unload using REST. There is no memory or performance hit as the size of the project grows, because modules remain on the server, ready for use, instead of taking up browser space.

To use **_EasyCoder_** all you need is to include its main JavaScript file in the _HEAD_ of your web page. It will call in any other JavaScript files it needs. An example is given in the Intro page of [our website](https://easycoder.github.io). You can alternatively build a standalone page where all the files are present on your own server, which avoids any possible risk of your site breaking when updates occur. SWe do our best to prevent this happening but it's impossible to cover all possibilities.

It is said that there's a shortage of competent programmers, a belief that's confirmed by the huge number of job vacancies all asking for skills such as React. If that's true then the use of React or similar tools in any project that is not managed by a permanent team is almost guaranteed to result in problems later with maintenance. If it's hard to find developers now then the chances of locating a skilled React engineer in 5-10 years' time at a price compatible with effective maintenance are vanishingly small.

**_EasyCoder_** tries to address this problem by offering a way to build websites that won't rely on such high-level skills, using the power of language rather than relying on elaborate structures to achieve the desired goal. In the hands of a competent programmer it makes little difference to the cost of building the project but a huge difference to that of maintaining it by people lacking those skills. **_EasyCoder_** scripts are easy to understand by anyone who has a good knowledge of what the site does, even by many people who aren't programmers at all.
Expand All @@ -29,7 +31,7 @@ There's a lot more information on [our website](https://easycoder.github.io), wh

## The Codex ##

The Codex is a page on [our website](https://easycoder.github.io) that provides a tutorial series plus a programming playground to try out code and a complete programmers' reference to the **_EasyCoder_** language. We also offer a zip file that can be unpacked on any suitable host.
The Codex is a page on [our website](https://easycoder.github.io) that provides a tutorial series plus a programming playground to try out code and a complete programmers' reference to the **_EasyCoder_** language.

## License ##

Expand Down
2 changes: 1 addition & 1 deletion easycoder/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EasyCoder distribution file set

Here are the files that will be used by EasyCoder applications. Not all will be needed for any given application but it's probably simplest to copy them all. The file `plugins,js` defines which plugins will be used by default (causing them to be loaded) so it should be edited if a different set is required.
Here are the files that can be used to create standalone EasyCoder applications. Not all will be needed for any given application but it's probably simplest to copy them all. The file `plugins,js` defines which plugins will be used by default (causing them to be loaded) so it should be edited if a different set is required.

Most of these files, particularly those in the `plugin` folder, are simply copies of the source set at `js`. The two files `easycoder.js` and `easycoder-min.js` are built from those sources; the latter is a minimized version of the former.

Expand Down