search

david-mark / My-Library

The original cross-browser JS library/framework
http://www.cinsoft.net/mylib.html
59 stars 14 forks source link

Build instructions #6

Open Raynos opened 12 years ago

Raynos commented 12 years ago

There are no instructions on how to turn mylib.asp into a javascript file.

This may be a good time to add a README.

recommended README.md format

Note the API documentation should just link to the website.

Also note that github projects without readmes are considered "unfriendly". At least I personally find them so.

Further note: Using asp as a build system is "ugly" and not very cross-platform system. It's "popular" these days to use node.js as a build system. Note that using node.js (or any other build system) would allow you to split the main mylib file into multiple files (similarly to how jQuery does so). As for being cross platform one can use makefiles to run a node build file in *unix environments and use windows .cmd files to run build scripts in a windows environment.

david-mark commented 12 years ago

On Sun, Jan 22, 2012 at 3:14 PM, Raynos < reply@reply.github.com

wrote:

There are no instructions on how to turn mylib.asp into a javascript file.

Right. You can use the builder (recommended) or globally replace the ASP directives.

This may be a good time to add a README.

[recommended README.md format][1]

Been meaning to do that.

Note the API documentation should just link to the website.

But I want the documentation in the repo so people can update it. :)

Also note that github projects without readmes are considered "unfriendly". At least I personally find them so.

Reply to this email directly or view it on GitHub: https://github.com/cinsoft/My-Library/issues/6

david-mark commented 12 years ago

Basically, replace "<%" with "//<%" in a text editor, reverse to put it back.

Or, if you have a Windows Web server that supports ASP (e.g. Personal Web Server on XP), you can run the app locally (much easier). I've been meaning to port the app to PHP, but haven't had time.

And ultimately, I will have to copy the changed file(s) to the Web server. The first of these updates will occur soon as I have patched a half-dozen bugs, typos, etc. in the last couple of weeks (and there are a few more mentioned in the discussion group and the old bug tracker).

On Sun, Jan 22, 2012 at 3:40 PM, David Mark dmark.cinsoft@gmail.com wrote:

On Sun, Jan 22, 2012 at 3:14 PM, Raynos < reply@reply.github.com

wrote:

There are no instructions on how to turn mylib.asp into a javascript file.

Right. You can use the builder (recommended) or globally replace the ASP directives.

This may be a good time to add a README.

[recommended README.md format][1]

Been meaning to do that.

Note the API documentation should just link to the website.

But I want the documentation in the repo so people can update it. :)

Also note that github projects without readmes are considered "unfriendly". At least I personally find them so.

Reply to this email directly or view it on GitHub: https://github.com/cinsoft/My-Library/issues/6